home *** CD-ROM | disk | FTP | other *** search
/ Ham Radio 2000 / Ham Radio 2000.iso / ham2000 / satellit / sqk00a / sqk.doc < prev    next >
Text File  |  1991-01-28  |  11KB  |  255 lines
  1.                          Super QK Version 0.0a
  2.                      (Preliminary Docs 1/28/1990)
  3.  
  4.         This program is the outgrowth of several little programs I
  5. wrote to complement Quiktrak 4.0 and QK programs. It deals with
  6. managing the keplerian data files used by Quiktrak. This version is
  7. just a preliminary version to see if my view of how a program
  8. should work is shared by anyone else! It is designed to replace the
  9. QK program distributed with Quiktrak
  10.  
  11.         I tried to follow the Quiktrak type of data entry. You can
  12. also enter the first letter of the menu selection or the position
  13. on the menu list. So on the main menu of:
  14.  
  15.  
  16.                         UPDATE
  17.                         RELOAD
  18.                         LIST
  19.                         SORT
  20.                         FILE
  21.                         CLEAR
  22.  
  23. Pressing the F key or the 5 key will select the file menu. A 0 will
  24. exit from the menu as in quicktrak.
  25.  
  26.         The command line augments are similar to QK.  Entering:
  27.  
  28. QK -?
  29.  
  30. will give a short help screen. So far the only other switch is -x
  31. which will exit the program after one operation (the same as qk).
  32. Accessing the file menu does not count as a operation. If you do
  33. not specify filenames, SuperQK uses stnmfile and kepfile for the
  34. default QT keplerian file names, bulletin.txt for the text file
  35. containing the new keplerian elements, and kepdata.dmp for the dump
  36. file.
  37.  
  38.                             Why SQK?
  39.  
  40.      I wanted a program that would deal with multiple Bulletin
  41. files and QT files. I wanted to have a way of loading Non-Keplerian
  42. information into quiktrak and to reorganize the QT files without
  43. having to reenter the non-keplerian data.
  44.  
  45. SETUP
  46.  
  47.         Since Quiktrak runs on IBM and close compatibles, so does
  48. SuperQK. This preliminary version uses simple highlighting, reverse
  49. video, and blinking only. Color may come later. But for now if you
  50. have a monitor that does not display the intensified colors (colors
  51. 8 - 15) then you can not see the highlighted text. This program
  52. should work on a system using a Monochrome Display Adapter (MDA) or
  53. Hercules.
  54.  
  55.      Put SuperQK in the same directory as Quiktrak.
  56.  
  57.                         Main Menu
  58.  
  59.  
  60.                         UPDATE
  61.                         RELOAD
  62.                         LIST
  63.                         SORT
  64.                         FILE        
  65.                         CLEAR
  66.  
  67.  
  68. These are the main features of the program I will deal with them on
  69. by one.
  70.  
  71.                         FILE  Menu
  72.  
  73.                            OPEN
  74.                         CLOSE/UPDATE
  75.                           DELETE
  76.                            VIEW
  77.                           ABANDON
  78.  
  79.  
  80. This menu allows you to do various operations to files. There are
  81. three basic types of files; Keplerian Data files that contain
  82. keplerian data in ASCII Text form. Quiktrack files that are binary
  83. files that Quiktrack uses. A list file containing ascii dumps of
  84. data in the binary Quiktrak files.  You will notice that the
  85. current names of the files are displayed most of the time on the
  86. top lines of the screen. If a file has been changed it is
  87. highlighted.
  88.  
  89.         Open opens a file. Another menu appears: 
  90.  
  91.  
  92.                 Keplerian Data File
  93.                  Quiktrak files
  94.                     List file
  95.  
  96. Select the type of file you want opened. A prompt will appear
  97. asking to enter a filename. A filename will be displayed as the
  98. default. Editing is similar to Quiktrak. If you enter a filename
  99. containing * or ? characters, a menu containing possible selections
  100. will appear. Use the cursor keys to position on the file you want
  101. and press return. If there is no files matching the pattern you
  102. will be prompted to supply another name.  The name entered on the
  103. file prompt line is used as the default  file name for the next
  104. file selection of this type.
  105.  
  106.      For example if you specify NASA-PB.708 as the file name, this
  107. is used as the default. If you specify NASA-PB.*, then select NASA-
  108. PB.708 from the list of files, NASA-PB.* will still be the default
  109. for the next selection of that file type. If you had a group of
  110. Keplerian files called GROUP001.TLE, GROUP002.TLE, etc..., then it
  111. is easy to specify GROUP*.* or GROUP*.TLE and have easy menu
  112. selection of the various files. If a file to be read does not
  113. exist, an error message is displayed and the default file name is
  114. unchanged. If the default name did not exist or no files exist with
  115. the same pattern as the filename containing the ? or * characters,
  116. then *.* is used as the default. The user can change the *.* to
  117. another file name.
  118.  
  119.      I wanted a way to be able to enter the name if I wanted to use
  120. just one file, or use a menu selection on a group of files. The
  121. initial default file name depends on the type of file and can be
  122. changed by parameters on the command line.
  123.  
  124.      The Quiktrak files are created if they do not exist. If they
  125. are created, the entries are initialized as if a clear command is
  126. done. I use default setting similar to the ones in the QT files
  127. that came with the Quiktrak program.  If a new file is selected,
  128. any updates to the old file will be written to the file and the old
  129. file will be closed before the new one is opened. This occurs even
  130. if the same filename is reentered. The Quiktrak files on the disk
  131. are only updated when any data is changed.
  132.  
  133.      Close/Update is really useful for the QT files. The QT files
  134. are not written until you exit the program, open another QT file,
  135. or use this menu selection. The Keplerian text file is read-only.
  136. You can "close" the Keplerian text file, but it is only opened,
  137. read, then closed when needed. The List file acts the same way for
  138. now, but this may change in future. The menus are the same as
  139. described under Open.
  140.  
  141.      Delete lets you delete a file. This is handy to delete the
  142. kepdata.dmp. New data is appended to the end of the file so use
  143. delete to start over. The menus are the same as described under
  144. Open.
  145.  
  146.      View lets you view a file. In this version the only files you
  147. can view are QT files. The arrow keys move you through the file and
  148. use the escape or return key to exit. The menus are the same as
  149. described under Open.
  150.  
  151.      Abandon is useful for the QT files. Abandon cancels any
  152. changes to a file since it was opened. For example if you reload a
  153. QT file, and then abandon it, the reload is canceled. The QT files
  154. are not written until you exit the program, or open another QT
  155. file. The Keplerian text file is read-only. You can "abandon" the
  156. Keplerian text file, but it is still opened, read, then closed when
  157. needed. The List file acts the same way for now, but this may
  158. change in future. The menus are the same as described under Open.
  159.  
  160.                              UPDATE
  161.  
  162.      I put update as the first selection because it is a commonly
  163. used function. It updates the QT Keplerian files by reading a NASA,
  164. AMSAT or formatted text file and looking for a non-case sensitive
  165. match of the satellite name or the ID number. QK puts the ID number
  166. and element set number in the ID string of the QK Keplerian file.
  167. SQK does the same and assumes the ID number is the first text in
  168. the ID field.
  169.  
  170.      The next prompt that appears after selecting UPDATE is to
  171. enter a range of entries to update. The default is 0 to 99 (The
  172. entire file). Note that I use the "programmer's convention" and
  173. numbered stuff starting at 0. All entry numbers assume the first
  174. entry is entry number 0. A similar type of prompt is used in other
  175. menu selections.
  176.  
  177.      If the keplerian data file does not exist or is a wildcard, a
  178. file selection prompt will be displayed. The filename entered
  179. because the default filename for the Keplerian data file if a
  180. filename with wildcards are entered, a menu of files matching the
  181. filename specification is displayed. 
  182.  
  183.      Next is menu of the Keplerian data file types. Select NASA for
  184. nasa type and AMSAT/TEXT for other types.
  185.  
  186.      The names of the satellites in the QT Keplerian files are
  187. displayed. Elements that are updated are highlighted. If a
  188. satellite is updated more than once the name will blink. Since both
  189. the name and ID are used to update the entry, a "swap" of names or
  190. ID numbers (which sometimes occurs after launch) between two
  191. satellites can cause this. Sometimes only one of the "swapped"
  192. entries will blink. The last element set that matches the Satellite
  193. Name or ID will be used to update the QT Keplerian files. The name
  194. is not updated, but the ID is updated.
  195.  
  196.                              RELOAD
  197.  
  198.      Reload is similar to the UPDATE function. The Keplerian data
  199. file replaces the existing data in the QT Keplerian files. Prompts
  200. are the same as UPDATE. Putting a letter i after the range numbers
  201. will cause any position numbers (preceded by a # on the first line)
  202. to be ignored when reading in the output of the list command. This
  203. allows resorting of the entries without having to erase the #
  204. entries.
  205.  
  206.                               LIST
  207.  
  208.      List allows you to display the binary data in the QT Keplerian
  209. files in a printable format. You can display entries on the screen
  210. or output them to the list file or printer. The list file can be
  211. read back in with the Reload or Update function using the
  212. AMSAT/TEXT format. This allows a text database of non-keplerian
  213. data to be created. If you enter a f after the range, the QT
  214. Keplerian files are appended to the filename specified as the dump
  215. file name. If a p is entered after the range, the QT Keplerian
  216. files are outputed to the printer.
  217.  
  218.      When viewing on the screen, the 0 or escape  key will return
  219. to the main menu. The Home key will display the first entry and the
  220. End key will display the last entry. The cursor keys will move to
  221. the various entries. Page Up and Page Down will move 10 entries at
  222. a time.
  223.  
  224.                             PERMISSION
  225.  
  226. Permission is granted for non-commercial use of this program by
  227. authorized users of QUIKTRAK 4.0 only. Permission is granted for AMSAT-NA
  228. (or national AMSAT group) to distribute this program.
  229.  
  230.  
  231.                               WARRANTY
  232.  
  233.      Or lack thereof.  THERE IS NO WARRANTY EXPLICIT OR IMPLICIT
  234. WITH THIS PROGRAM.  You received this program for a donation to
  235. AMSAT and therefore it should NOT be treated as a commercial
  236. product and we will not treat it as such.
  237.  
  238.                               LIABILITY
  239.  
  240.      The Author, AMSAT-NA and any other group authorized by AMSAT-NA to 
  241. distribute this program assumes NO LIABILITY for any damage caused
  242. by this program directly or indirectly.  This program is sold AS
  243. IS.  Any "BUGS" will be fixed in the next release and this will NOT
  244. entitle you to an automatic update.
  245.  
  246.                                AUTHOR
  247.  
  248.      Eric A. Cottrell 37 Centre St, Lynn, Ma 01905
  249. WB1HBU @ K1UGM.#EMA.MA.USA.NA.EARTH.SOL.MILKYWAY.UNIV 
  250. CIS:76327,515 Easyplex or Hamnet.
  251.  
  252. AMSAT-NA, P.O. Box 27, Washington, D.C. 20044 (301)-589-6062      
  253. Happy Keplerian Updating!!
  254. 
  255.